Fix name resolution in typedef and allow defaults for template tags by rbuckton · Pull Request #45483 · microsoft/TypeScript

rbuckton · 2021-08-17T03:24:48Z

This adds support for Type Parameter defaults in JavaScript files using the JSDoc @template tag. The implementation borrows from the syntax used for parameter defaults in JSDoc (namely [foo=1]):

/**
 * @template {string} [T="hello"]
 * @typedef {T} Foo
 */

This also fixes a name resolution bug when checking the constraint of a @template tag.

Fixes #45480
Fixes #45481

sandersn

Looks good, one request in the parser and one in the tests.

src/compiler/parser.ts

tests/baselines/reference/jsdocTemplateTagDefault.errors.txt

src/compiler/parser.ts

rbuckton · 2021-08-27T23:31:58Z

I'm debating whether [T] should be allowed, and if so, if it should default to the constraint or unknown. Given the changes necessary to support that, I may look at that in a separate PR instead.

rbuckton · 2021-08-27T23:34:43Z

@sandersn can you take another look?

rbuckton · 2021-08-28T01:22:57Z

@typescript-bot test this
@typescript-bot user test this

typescript-bot · 2021-08-28T01:23:00Z

Heya @rbuckton, I've started to run the parallelized community code test suite on this PR at 9131c0c. You can monitor the build here.

typescript-bot · 2021-08-28T01:23:00Z

Heya @rbuckton, I've started to run the extended test suite on this PR at 9131c0c. You can monitor the build here.

typescript-bot · 2021-08-28T01:55:17Z

The user suite test run you requested has finished and failed. I've opened a PR with the baseline diff from master.

rbuckton · 2021-08-30T18:34:06Z

User Tests: lots of diffs in baselines, but none seem related to this change.
- NOTE: Prettier has same OOM as Adds 'Awaited' type alias and updates to Promise.all/race/allSettled/any #45350 (comment), so I think there's something unrelated to this PR or Adds 'Awaited' type alias and updates to Promise.all/race/allSettled/any #45350.
RWC: no changes of note.

andrewbranch · 2021-08-30T19:51:02Z

@rbuckton FYI you can run @typescript-bot user test this inline to get a user test diff between this and current main, with results posted in the PR.

typescript-bot · 2021-08-30T19:51:21Z

Heya @andrewbranch, I've started to run the inline community code test suite on this PR at 9131c0c. You can monitor the build here.

Update: The results are in!

typescript-bot · 2021-08-30T20:05:19Z

@andrewbranch
Great news! no new errors were found between main..refs/pull/45483/merge

rbuckton · 2021-08-31T01:14:11Z

Wasn't aware of the inline, and I'm not sure why that's not the default behavior, tbh.

rbuckton · 2021-09-04T18:40:35Z

@DanielRosenwasser: Do we want to discuss the syntax for this in a design meeting, or is this ok to merge?

tests/cases/conformance/jsdoc/jsdocTemplateTagNameResolution.ts

rbuckton · 2021-09-08T21:45:34Z

TODO:

Verify JS declaration emit.

DanielRosenwasser · 2021-09-14T21:00:37Z

So the syntax

@template {string} [T="hello"]

means

T extends string = "hello"

I can't wait to never get this right. 😂

thw0rted · 2021-09-20T12:02:41Z

Hi @rbuckton , I noticed that none of the files changed in this PR seem to be documentation (HTML/MD). Is that hosted in a different repo? Is there a task / issue to track inclusion of this syntax in the handbook?

orta · 2021-11-03T14:03:23Z

Just noting that the new JSDoc reference on the site includes this

Remove a cryptic piece of code that is no longer needed given the ability to specify default values for template arguments [1] [1] microsoft/TypeScript#45483

rbuckton requested review from sandersn and weswigham August 17, 2021 03:24

typescript-bot assigned rbuckton Aug 17, 2021

typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Aug 17, 2021

Fix name resolution in typedef and allow defaults for template tags

3d9187f

rbuckton force-pushed the jsDocTemplateTagDefault branch from 80fa780 to 3d9187f Compare August 17, 2021 22:25

typescript-bot added For Backlog Bug PRs that fix a backlog bug and removed For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Aug 17, 2021

sandersn requested changes Aug 19, 2021

View reviewed changes

src/compiler/parser.ts Outdated Show resolved Hide resolved

tests/baselines/reference/jsdocTemplateTagDefault.errors.txt Show resolved Hide resolved

src/compiler/parser.ts Outdated Show resolved Hide resolved

Inline parseBracketNameInTemplateTag

8460ea4

rbuckton added 2 commits August 27, 2021 17:27

Merge branch 'main' into jsDocTemplateTagDefault

9e24ccf

Update baselines

9131c0c

typescript-bot mentioned this pull request Aug 28, 2021

🤖 User test baselines have changed for jsDocTemplateTagDefault typescript-bot/TypeScript#201

Open

sandersn approved these changes Sep 3, 2021

View reviewed changes

weswigham reviewed Sep 8, 2021

View reviewed changes

tests/cases/conformance/jsdoc/jsdocTemplateTagNameResolution.ts Show resolved Hide resolved

andrewbranch mentioned this pull request Sep 8, 2021

Design Meeting Notes, 9/8/2021 #45790

Closed

Add js declaration emit tests

490e681

weswigham approved these changes Sep 8, 2021

View reviewed changes

rbuckton merged commit cf787e9 into main Sep 9, 2021

rbuckton deleted the jsDocTemplateTagDefault branch September 9, 2021 00:05

intrnl mentioned this pull request Sep 18, 2021

default types for @template generics in JSDoc #29401

Closed

robertknight mentioned this pull request Oct 18, 2021

Strengthen the types for Bridge events hypothesis/client#3838

Merged

IllusionMH mentioned this pull request Oct 29, 2021

JSdoc template defaults syntax not work #46574

Closed

robertknight added a commit to hypothesis/client that referenced this pull request Mar 24, 2022

Remove DefaultIfAny helper

0a6294a

Remove a cryptic piece of code that is no longer needed given the ability to specify default values for template arguments [1] [1] microsoft/TypeScript#45483

robertknight mentioned this pull request Mar 24, 2022

Remove DefaultIfAny helper hypothesis/client#4349

Merged

robertknight added a commit to hypothesis/client that referenced this pull request Mar 24, 2022

Remove DefaultIfAny helper

788697e

Remove a cryptic piece of code that is no longer needed given the ability to specify default values for template arguments [1] [1] microsoft/TypeScript#45483

tschaub mentioned this pull request May 23, 2022

no-undefined-types: false positive for template tags with defaults gajus/eslint-plugin-jsdoc#887

Closed

stof mentioned this pull request Sep 2, 2025

Template types with default values are not recognized properly. gajus/eslint-plugin-jsdoc#1464

Closed

microsoft locked as resolved and limited conversation to collaborators Oct 21, 2025

Conversation

rbuckton commented Aug 17, 2021

Uh oh!

sandersn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rbuckton commented Aug 27, 2021

Uh oh!

rbuckton commented Aug 27, 2021

Uh oh!

rbuckton commented Aug 28, 2021

Uh oh!

typescript-bot commented Aug 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Aug 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Aug 28, 2021

Uh oh!

rbuckton commented Aug 30, 2021

Uh oh!

andrewbranch commented Aug 30, 2021

Uh oh!

typescript-bot commented Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Aug 30, 2021

Uh oh!

rbuckton commented Aug 31, 2021

Uh oh!

rbuckton commented Sep 4, 2021

Uh oh!

Uh oh!

rbuckton commented Sep 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DanielRosenwasser commented Sep 14, 2021

Uh oh!

thw0rted commented Sep 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

orta commented Nov 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

typescript-bot commented Aug 28, 2021 •

edited

Loading

typescript-bot commented Aug 28, 2021 •

edited

Loading

typescript-bot commented Aug 30, 2021 •

edited

Loading

rbuckton commented Sep 8, 2021 •

edited

Loading

thw0rted commented Sep 20, 2021 •

edited

Loading